<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.sites.html">sites</a> . <a href="apigee_v1.organizations.sites.apidocs.html">apidocs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new catalog item.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a catalog item.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a catalog item.</p>
<p class="toc_element">
  <code><a href="#getDocumentation">getDocumentation(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the documentation for the specified catalog item.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the catalog items associated with a portal.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a catalog item.</p>
<p class="toc_element">
  <code><a href="#updateDocumentation">updateDocumentation(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new catalog item.

Args:
  parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
  body: object, The request body.
    The object takes the form of:

{ # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
  &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
  &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
  &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
    &quot;A String&quot;,
  ],
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
  &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
  &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
  &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
  &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
  &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
  &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
  &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
  &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
  &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
  &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item resource wrapped with response status, error_code, etc.
  &quot;data&quot;: { # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
    &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
    &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
    &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
      &quot;A String&quot;,
    ],
    &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
    &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
    &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
    &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
    &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
    &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
    &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
    &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
    &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
    &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
    &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
  },
  &quot;errorCode&quot;: &quot;A String&quot;, # Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a catalog item.

Args:
  name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for certain delete operations.
  &quot;errorCode&quot;: &quot;A String&quot;, # Unique error code for the request, if any.
  &quot;gcpResource&quot;: &quot;A String&quot;, # Google Cloud name of deleted resource.
  &quot;message&quot;: &quot;A String&quot;, # Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a catalog item.

Args:
  name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item resource wrapped with response status, error_code, etc.
  &quot;data&quot;: { # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
    &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
    &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
    &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
      &quot;A String&quot;,
    ],
    &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
    &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
    &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
    &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
    &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
    &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
    &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
    &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
    &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
    &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
    &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
  },
  &quot;errorCode&quot;: &quot;A String&quot;, # Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="getDocumentation">getDocumentation(name, x__xgafv=None)</code>
  <pre>Gets the documentation for the specified catalog item.

Args:
  name: string, Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item documentation wrapped with response status, error_code, etc.
  &quot;data&quot;: { # The documentation for a catalog item. # Output only. The documentation resource.
    &quot;graphqlDocumentation&quot;: { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
      &quot;schema&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
        &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
    &quot;oasDocumentation&quot;: { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
      &quot;format&quot;: &quot;A String&quot;, # Output only. The format of the input specification file contents.
      &quot;spec&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
        &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
  },
  &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Output only. Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Output only. Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Output only. Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns the catalog items associated with a portal.

Args:
  parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
  pageSize: integer, Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  pageToken: string, Optional. A page token, received from a previous `ListApiDocs` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;data&quot;: [ # The catalog item resources.
    { # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
      &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
      &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
      &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
        &quot;A String&quot;,
      ],
      &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
      &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
      &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
      &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
      &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
      &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
      &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
      &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
      &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
      &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
      &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
      &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
      &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
      &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
    },
  ],
  &quot;errorCode&quot;: &quot;A String&quot;, # Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Description of the operation.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;requestId&quot;: &quot;A String&quot;, # Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
  <pre>Updates a catalog item.

Args:
  name: string, Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}` (required)
  body: object, The request body.
    The object takes the form of:

{ # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
  &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
  &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
  &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
    &quot;A String&quot;,
  ],
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
  &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
  &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
  &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
  &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
  &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
  &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
  &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
  &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
  &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
  &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item resource wrapped with response status, error_code, etc.
  &quot;data&quot;: { # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products. # The catalog item resource.
    &quot;anonAllowed&quot;: True or False, # Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
    &quot;apiProductName&quot;: &quot;A String&quot;, # Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
    &quot;categoryIds&quot;: [ # Optional. The IDs of the API categories to which this catalog item belongs.
      &quot;A String&quot;,
    ],
    &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the catalog item. Max length is 10,000 characters.
    &quot;edgeAPIProductName&quot;: &quot;A String&quot;, # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
    &quot;graphqlEndpointUrl&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchema&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;graphqlSchemaDisplayName&quot;: &quot;A String&quot;, # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the catalog item.
    &quot;imageUrl&quot;: &quot;A String&quot;, # Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files&quot;), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won&#x27;t be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
    &quot;modified&quot;: &quot;A String&quot;, # Output only. Time the catalog item was last modified in milliseconds since epoch.
    &quot;published&quot;: True or False, # Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
    &quot;requireCallbackUrl&quot;: True or False, # Optional. Whether a callback URL is required when this catalog item&#x27;s API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app&#x27;s OAuth flow).
    &quot;siteId&quot;: &quot;A String&quot;, # Output only. The ID of the parent portal.
    &quot;specId&quot;: &quot;A String&quot;, # Optional. DEPRECATED: DO NOT USE
    &quot;title&quot;: &quot;A String&quot;, # Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
    &quot;visibility&quot;: True or False, # Optional. DEPRECATED: use the `published` field instead
  },
  &quot;errorCode&quot;: &quot;A String&quot;, # Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Status of the operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="updateDocumentation">updateDocumentation(name, body=None, x__xgafv=None)</code>
  <pre>Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

Args:
  name: string, Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation` (required)
  body: object, The request body.
    The object takes the form of:

{ # The documentation for a catalog item.
  &quot;graphqlDocumentation&quot;: { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
    &quot;endpointUri&quot;: &quot;A String&quot;, # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
    &quot;schema&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
      &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
    },
  },
  &quot;oasDocumentation&quot;: { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
    &quot;format&quot;: &quot;A String&quot;, # Output only. The format of the input specification file contents.
    &quot;spec&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
      &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog item documentation wrapped with response status, error_code, etc.
  &quot;data&quot;: { # The documentation for a catalog item. # Output only. The documentation resource.
    &quot;graphqlDocumentation&quot;: { # GraphQL documentation for a catalog item. # Optional. GraphQL documentation.
      &quot;endpointUri&quot;: &quot;A String&quot;, # Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.
      &quot;schema&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the GraphQL schema.
        &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
    &quot;oasDocumentation&quot;: { # OpenAPI Specification documentation for a catalog item. # Optional. OpenAPI Specification documentation.
      &quot;format&quot;: &quot;A String&quot;, # Output only. The format of the input specification file contents.
      &quot;spec&quot;: { # Documentation file contents for a catalog item. # Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
        &quot;contents&quot;: &quot;A String&quot;, # Required. The file contents. The max size is 4 MB.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. A display name for the file, shown in the management UI. Max length is 255 characters.
      },
    },
  },
  &quot;errorCode&quot;: &quot;A String&quot;, # Output only. Unique error code for the request, if any.
  &quot;message&quot;: &quot;A String&quot;, # Output only. Description of the operation.
  &quot;requestId&quot;: &quot;A String&quot;, # Output only. Unique ID of the request.
  &quot;status&quot;: &quot;A String&quot;, # Output only. Status of the operation.
}</pre>
</div>

</body></html>